home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / fscmd / RCS / fscmd.man,v < prev   
Text File  |  1992-08-07  |  9KB  |  278 lines
  1. head     1.2;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    shirriff:1.2; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.2
  10. date     88.12.30.09.28.33;  author ouster;  state Exp;
  11. branches ;
  12. next     1.1;
  13.  
  14. 1.1
  15. date     88.12.21.11.30.00;  author ouster;  state Exp;
  16. branches ;
  17. next     ;
  18.  
  19.  
  20. desc
  21. @@
  22.  
  23.  
  24. 1.2
  25. log
  26. @More format upgrades.
  27. @
  28. text
  29. @' $Header: /a/newcmds/fscmd/RCS/fscmd.man,v 1.1 88/12/21 11:30:00 ouster Exp Locker: ouster $ SPRITE (Berkeley)
  30. .so \*(]ltmac.sprite
  31. .HS FSCMD cmds
  32. .BS
  33. .SH NAME
  34. fscmd \- Set various parameters in the filesystem
  35. .SH SYNOPSIS
  36. .nf
  37. \fBfscmd\fR \-[\fBmM\fR] \fIsize\fR
  38. \fBfscmd\fR \-[\fBfslLNCv\fR] \fR
  39. \fBfscmd\fR \-[\fBwWxXyz\fR] \fR
  40. \fBfscmd\fR \-[\fBBOtDR\fR] \fR
  41. .fi
  42. .BE
  43. .SH INTRODUCTION
  44. This command is used to set various kernel variables that control
  45. the filesystem cache, tracing and debugging output, and other
  46. features of the system.
  47. It is implemented using the Fs_Command system call.
  48. .SH CACHE SIZE
  49. The minimum and maximum number of filesystem blocks (4 Kbytes each) in the
  50. main memory cache is set with the -m (minimum) and -M (maximum)
  51. arguments.  Follow either of these with the number of 4-Kbyte blocks, ie.
  52. -M 512 means a max of 2 Megabytes in the cache.
  53. .SH CACHE CONTROL
  54. .IP "\fB\-f"
  55. The entire contents of the cache gets written-back and then invalidated by
  56. specifying \fB\-f\fP.
  57. .IP "\fB\-s\fR [\fB0\fR|\fB1\fR]"
  58. The background process that writes back dirty data from the cache
  59. can be
  60. disabled
  61. by specifying the
  62. ``\fB\-s 0\fP''
  63. flag.  This should be done when patching a mounted filesystem
  64. or else bad internal structures will get pushed to disk.
  65. Enable the sync daemon with ``\fB\-s 1\fP''.
  66. .IP "\fB\-l\fR [\fB0\fR|\fB0\fR]"
  67. Biasing against ``large'' files in the cache is enabled with ``\fB\-l 1\fR''
  68. and turned off with ``\fB\-l 0\fR''.
  69. .IP "\fB\-L \fIsize\fR"
  70. This sets what portion of the maximum cache size a file must occupy before
  71. it is considered
  72. a large file.  For example a value of 8 would indicate that if a file is larger
  73. than 1/8 of the maximum cache size then it is considered a large file.
  74. .IP "\fB\-C\fR [\fB0\fR|\fB0\fR]"
  75. Caching on diskless nodes can be disabled with ``\fB\-C 0\fR'',
  76. and turned back on with ``\fB\-C 1\fR''.
  77. This has to be done on a file server to affect its clients; use of the -C
  78. flag on clients will have no effect.
  79. .IP "\fB\-N\fR [\fB0\fR|\fB0\fR]"
  80. The name cache on a diskfull node is disabled with
  81. ``\fB\-N 0\fR'' and enabled with ``\fB\-N 1\fR''.
  82. .IP "\fB\-v\fR [\fB0\fR|\fB0\fR]"
  83. The Virtual Memory cache of recently used program segments is
  84. disabled with ``\fB\-v 1\fR'' (yes, 1), and enabled with ``\fB\-v 0\fR''.
  85. .IP "\fB\-b \fIN\fR"
  86. Set the maximum number of block cleaner processes.  This controls the
  87. amount of overlap during cache writebacks.  3 processes provides the most
  88. bandwidth, but it does load the server.
  89. .IP "\fB\-r \fIN\fR"
  90. Set the read ahead distance (in 4K blocks).  When a read on the cache
  91. is done, the transfer of N more blocks is initiated.
  92. .SH "CACHE WRITE BACK POLICY"
  93. Normally, dirty blocks in the file system cache are aged for at least
  94. 30 seconds before being written back.  This gives the best performance,
  95. although alternate strategies can be tried out with the following flags.
  96. There are two write-back policies involved: the client's and the server's.
  97. Each of the flags below only affects the policy on the client or server
  98. on which it is invoked.  For example the client could be using a
  99. write-through policy and the server a 30-second-delay policy.  This would
  100. mean that client writes would not complete until the blocks have been written
  101. across the network into the server's cache, but the blocks would not be
  102. written back to disk until at least 30 seconds later.
  103. .IP "\fB\-S \fIseconds\fR"
  104. Set the cache write-back interval in seconds. 
  105. .IP "\fB\-w\fR [\fB0\fR|\fB0\fR]"
  106. Write-through caching is enabled with ``\fB\-w 1\fR'' and
  107. disabled with ``\fB\-w 0\fR''.  With write-through,
  108. the write system call does not complete until
  109. the cache block is written back. 
  110. .IP "\fB\-W [\fB0\fR|\fB0\fR]"
  111. Write-back-on-close caching is enabled with
  112. ``\fB\-W 1\fR'' and disabled with ``\fB\-W 0\fR''.
  113. With write-back-on-close the close system call does not complete
  114. until all of the file's dirty blocks are written back.  
  115. .IP "\fB\-x\fR [\fB0\fR|\fB0\fR]"
  116. Write-back of temporary files can be set to delay as long as possible
  117. with ``\fB\-x 1\fR''.  This is turned off with ``\fB\-x 0\fR''.  Normally temporary files are
  118. files that are in the /tmp directory.
  119. .IP "\fB\-X \fIdirNumber\fR"
  120. This identifies the temporary directory to the file system.
  121. \fIdirNumber\fP should be the inode number of /tmp.
  122. Unfortunately, only one temporary directory is understood.
  123. .IP "\fB\-y\fR [\fB0\fR|\fB0\fR]
  124. Write-back-as-soon-as-possible caching is enabled with ``\fB\-y 1\fR''
  125. and turned off with ``\fB\-y 0\fR''.
  126. With write-back-ASAP, the write system call completes immediately
  127. and the cache block is scheduled to be written out as-soon-as-possible.
  128. .IP "\fB\-z\fR [\fB0\fR|\fB0\fR]"
  129. Write-back-on-last-dirty-block caching is enabled with ``\fB\-z 1\fR''
  130. and turned off with ``\fB\-z 0\fR''.
  131. This policy only works on a server.  It 
  132. means the server writes back its blocks for a file
  133. after getting the last dirty block for the file from a client.  For example,
  134. this policy combined with a write-back-on-close client policy would mean
  135. that after a client closes a file, all of the files blocks are guaranteed
  136. to be on the server's disk.
  137. .SH DISK LAYOUT
  138. .IP "\fB\-B \fIskew\fR"
  139. Set the block skew for disk allocation.  Not supported in kernel yet.
  140. .SH TRACING/DEBUG FLAGS
  141. There are several tracing/debugging flags that can have their
  142. value set via \fBfscmd\fR.  Each flag expects a following integer
  143. on the command line that will specify the new value of
  144. the flag or trace level variable.  \fBFscmd\fR prints out the
  145. old value of the flag as it changes it.
  146. Some of the flags are Booleans that are
  147. set with values of 1 for TRUE, and 0 for FALSE.
  148. .IP "\fB\-O\fR"
  149. The fsStats structure is zeroed out.  This information is displayed
  150. with the fsStat program.
  151. .IP "\fB\-t\fR [\fB0\fR|\fB0\fR]"
  152. Filesystem tracing is enabled with ``\fB\-t 1\fR''.  This dumps internal events
  153. into a circular trace record.  The trace gets printed via a
  154. special console key sequence, ``\fBL1-f\fR''.
  155. .IP "\fB\-D\fR [\fB0\fR|\fB0\fR]"
  156. Cache consistency debug print statements are turned on with ``\fB\-D 1\fR'',
  157. and turned off with ``\fB\-D 0\fR''.
  158. .IP "\fB\-R\fR [\fB0\fR|\fB0\fR]"
  159. Read ahead tracing is enabled with ``\fB\-R 1\fR'' and turned off with ``\fB\-R 0\fR''.
  160. .SH "SEE ALSO"
  161. fsStat, prefix, rpcCmd
  162. .SH FILES
  163. .nf
  164. /local/diskcmds        - Server local startup file
  165. /bootcmds        - Network wide startup file
  166. .SH KEYWORDS
  167. debugging, trace, cache, write-back
  168. @
  169.  
  170.  
  171. 1.1
  172. log
  173. @Initial revision
  174. @
  175. text
  176. @d1 1
  177. a1 1
  178. ' $Header: /sprite/doc/ref/cmds/RCS/fscmd,v 1.2 88/05/05 09:38:49 nelson Exp Locker: brent $ SPRITE (Berkeley)
  179. d9 4
  180. a12 4
  181. \fBfscmd\fR -[\fBmM\fR] \fIsize\fR
  182. \fBfscmd\fR -[\fBfslLNCv\fR] \fR
  183. \fBfscmd\fR -[\fBwWxXyz\fR] \fR
  184. \fBfscmd\fR -[\fBBOtDR\fR] \fR
  185. d26 1
  186. a26 1
  187. .IP "\fB-f"
  188. d28 2
  189. a29 2
  190. specifying \fB-f\fP.
  191. .IP "\fB-s\fR [\fB0\fR|\fB1\fR]"
  192. d34 1
  193. a34 1
  194. ``\fB-s 0\fP''
  195. d37 5
  196. a41 5
  197. Enable the sync daemon with ``\fB-s 1\fP''.
  198. .IP "\fB-l\fR [\fB0\fR|\fB0\fR]"
  199. Biasing against ``large'' files in the cache is enabled with ``\fB-l 1\fR''
  200. and turned off with ``\fB-l 0\fR''.
  201. .IP "\fB-L \fIsize\fR"
  202. d46 3
  203. a48 3
  204. .IP "\fB-C\fR [\fB0\fR|\fB0\fR]"
  205. Caching on diskless nodes can be disabled with ``\fB-C 0\fR'',
  206. and turned back on with ``\fB-C 1\fR''.
  207. d51 1
  208. a51 1
  209. .IP "\fB-N\fR [\fB0\fR|\fB0\fR]"
  210. d53 2
  211. a54 2
  212. ``\fB-N 0\fR'' and enabled with ``\fB-N 1\fR''.
  213. .IP "\fB-v\fR [\fB0\fR|\fB0\fR]"
  214. d56 2
  215. a57 2
  216. disabled with ``\fB-v 1\fR'' (yes, 1), and enabled with ``\fB-v 0\fR''.
  217. .IP "\fB-b \fIN\fR"
  218. d61 1
  219. a61 1
  220. .IP "\fB-r \fIN\fR"
  221. d75 1
  222. a75 1
  223. .IP "\fB-S \fIseconds\fR"
  224. d77 3
  225. a79 3
  226. .IP "\fB-w\fR [\fB0\fR|\fB0\fR]"
  227. Write-through caching is enabled with ``\fB-w 1\fR'' and
  228. disabled with ``\fB-w 0\fR''.  With write-through,
  229. d82 1
  230. a82 1
  231. .IP "\fB-W [\fB0\fR|\fB0\fR]"
  232. d84 1
  233. a84 1
  234. ``\fB-W 1\fR'' and disabled with ``\fB-W 0\fR''.
  235. d87 1
  236. a87 1
  237. .IP "\fB-x\fR [\fB0\fR|\fB0\fR]"
  238. d89 1
  239. a89 1
  240. with ``\fB-x 1\fR''.  This is turned off with ``\fB-x 0\fR''.  Normally temporary files are
  241. d91 1
  242. a91 1
  243. .IP "\fB-X \fIdirNumber\fR"
  244. d95 3
  245. a97 3
  246. .IP "\fB-y\fR [\fB0\fR|\fB0\fR]
  247. Write-back-as-soon-as-possible caching is enabled with ``\fB-y 1\fR''
  248. and turned off with ``\fB-y 0\fR''.
  249. d100 3
  250. a102 3
  251. .IP "\fB-z\fR [\fB0\fR|\fB0\fR]"
  252. Write-back-on-last-dirty-block caching is enabled with ``\fB-z 1\fR''
  253. and turned off with ``\fB-z 0\fR''.
  254. d110 1
  255. a110 1
  256. .IP "\fB-B \fIskew\fR"
  257. d114 1
  258. a114 1
  259. value set via fscmd.  Each flag expects a following integer
  260. d116 1
  261. a116 1
  262. the flag or trace level variable.  fscmd prints out the
  263. d120 1
  264. a120 1
  265. .IP "\fB-O\fR"
  266. d123 2
  267. a124 2
  268. .IP "\fB-t\fR [\fB0\fR|\fB0\fR]"
  269. Filesystem tracing is enabled with ``\fB-t 1\fR''.  This dumps internal events
  270. d127 5
  271. a131 5
  272. .IP "\fB-D\fR [\fB0\fR|\fB0\fR]"
  273. Cache consistency debug print statements are turned on with ``\fB-D 1\fR'',
  274. and turned off with ``\fB-D 0\fR''.
  275. .IP "\fB-R\fR [\fB0\fR|\fB0\fR]"
  276. Read ahead tracing is enabled with ``\fB-R 1\fR'' and turned off with ``\fB-R 0\fR''.
  277. @
  278.